FST-Viewer V2.2 Readme


Inhalt

1. Was ist FST und der FST-Viewer?
2. Das Programm

3. Die FST-Technologie
3.1 Die Syntax der FST-Dateien
3.2 Die Symbolik
3.3 Befehlsreferenz
3.4 SELECT
3.5 Formatierung

4. Befehlszeile und Dateianbindung

5. Bekannte Bugs

6. Copyright


1. WAS IST FST UND DER FST-VIEWER?

FST = "Formatted Story-File" = Formartiere Geschichts-Datei

Diese Technologie erlaubt ablaufgesteuerte Texte darstellen zu knnen,
wobei der Benutzer entscheidet, wo er wie weitergehen will.

Der Viewer gestattet liest die FST-Dateien und gibt die,
entsprechend der FST-Technik aus.


2. DAS PROGRAMM

Das Programm ffnet eine FST-Datei und liest den ersten Sektor.

"Datei-ffnen" ffnet eine andere FST-Datei
"Datei-Schlieen" schliet die aktuelle Datei
"Datei-Ende" schliet den Viewer

"Info-Dateiinfo" gibt die Dateiinformationen an, wie Autor.
"Info-Programminfo" gibt Informationen ber den Viewer selbst an.

"Navigation-Anfang" zeigt wieder die Seite vom ersten Sektor an.
"Navigation-Gehe zu..." ffnet ein Fenster, wo jeder Sektor angewhlt werden kann.

"System-Version 1.0" verwendet die Version 1.0 der FST-Technologie.
	Diese Version hat einen reduzierten Bereich von Befehlen, arbeitet aber, im
	Zweifelsfall, schneller.
"System-Version 2.0" verwendet die Version 2.0 der FST-Technologie.
	Das ist neuste Version der FST-Technologie.
	Allerdings ist diese etwas anspruchsvoller als Version 1.0 und
	weil der Befehlszeichensatz grer ist, sind bestimmte Zeichenkombinationen
	nicht mehr zulssig!

Benutzen Sie das Keyboard, um SELECT-Statements anzuwhlen.


3. DIE FST-TECHNOLOGIE

3.1 Die Syntax der FST-Dateien

Jede FST-Datei kann mit einem gewhnlichen Text-Editor
bearbeitet werden.

Zwingend ist folgender Header und Syntax:

(Version 1.0)

FST [Version]
<DATA>
[Autorname]
[Version]
[Modus]
<FONT>
[Schrift Text]
[Schrift Titel]
[Schrift Sprache]
[Schrift Auswahl]
[Schrift Auswahl-Titel]
[Schrift Kommentar]
<TITLE>
[Titel]
<BODY>
$$[Startsektor]
...
<END>

(Version 2.0)

FST [Version]
<DATA>
[Autorname]
[Version]
[Modus]
<FONT>
[Schrift Text]
[Schrift Titel]
[Schrift Sprache]
[Schrift Auswahl]
[Schrift Auswahl-Titel]
[Schrift Kommentar]
<UFONT>
[Eigene Schriften]
...
<CONTROLS>
useFormatSpeech
useFormatComment
<TITLE>
[Titel]
<BODY>
$$[Startsektor]
...
<END>


Alle Angaben in []-Klammern sind durch die entsprechenden Werte zu
ersetzen!
Die [] sind dann wegzulassen!

Schriften erfordern den Syntax:
Name/Gre/Attribute/Farbe

Name = Glter Schriftartenname
Gre = Schriftgrad
Attribute = Kombination aus B (Fett), I (Kursiv) und/oder U (Unterstrichen)
Farbe = BGR-Hexwert (RGB-invertiert)

(nur Version 2.0)
Es knnen beliebige eigene Schriftarten (<UFONT>) definiert werden.
Auch die Anzahl ist unbegrenzt.
Fehlt der Bereich oder ist der Bereich leer, werden ALLE Steuerzeichen der
Formatierungs-Klasse, also "$" und "%", ignoriert!

"useFormatSpeech" entscheidet ob wrtliche Reden, also nicht-Kommentar oder SELECT-Texte
	in Anfhrungsstrichen <"...">, durch die Schrift "Sprache" hervorgehoben werden.
	Wenn "useFormatSpeech=1" angegeben oder der Punkt gnzlich fehlt,
	um die Formatierung zu aktivieren. "useFormatSpeech=0" deaktiviert die Formatierung
	und lsst wrtliche Reden.
"useFormatComment" entscheidet ob Kommentare hervorgehoben werden.
	Kommentare sind Texte, auch wrtliche Reden, die von runden Klammern <(...)>
	eingeschlossen sind. Sie werden mit der Schrift "Kommentar" formatiert.
	Es gelten dieselben Regeln fr das aktivieren bzw deaktivieren, wie bei
	"useFormatSpeech".


3.2 Die Symbolik

<...> = Befehlswort
$$... = Markierung
//... = Kommentar (ist im Viewer unsichtbar!)
... = Schlsselwort (siehe Befehelsreferenz)

Alle Symbole sollten am Zeilenanfang stehen!
Symbole, die in der Mitte einer Zeile auftauchen, werden zwar beachtet, doch
die ggf nachfolgenden Werte knnten fehlinterpretiert werden!

3.3 Befehlsreferenz

In einem Sektor (einen Text-Abschnitt im Krper der FST-Datei, der
zu einem Markierung gehrt) drfen folgende Schlsselwrter verwendet werden:

TITLE [Titel]
Hebt den Text "Titel" besonders vor.
Nimmt eine ganze Zeile ein und darf nur am Zeilenanfang stehen!

"..."
Markiert eine Wrtliche Rede.

(...)
Markiert einen sichtbaren Kommentar

SELECT, POS und &
siehe 3.4!


(nur Version 2.0)
$[Nummer]
Fordert den Viewer auf, eine selbstdefinierte Schrift zu verwenden.
[Nummer] ist optional.
Es gilt:
Die Indizes der selbstdefinierten Schriften beginnen bei "1" und zhlen aufwrts.
Wird die "Nummer" in der Liste gefunden beginnt ab diesem Steuerzeichen die Formatierung.
Wenn nicht, wird das Steuerzeichen ignoriert.
Wird keine "Nummer" angegeben, so wird die standartmig die Schrift #1 verwendet.

Diese Formatierung bleibt ber Abstze, wrtliche Reden, SELECTS und Kommentare erhalten.
Nach einem Titel oder am beginn eines neuen Sektors, wird wieder die standart-Schrift
verwendet.

%
Normalisiert die Schrift wieder zum Standart.


3.4 SELECT

Dieser Statement-Block gestattet die Ablaufsteuerung.

Folgender Syntax ist einzuhalten:

SELECT [Select-Titel]
POS [Pos-Name] ?= [Ziel] #[Taste]
POS ...
...
&

[Select-Titel] umfasst den Titel oder Aufforderung fr die
Auswahl.

[Pos-Name] bezeichnet den Name dieser Auswahlmglichkeit.

[Ziel] muss eine gltige Markierung sein (ohne $$-Prfix) die
angesteuert werden muss.

[Taste] eine Buchstabentaste (in Grobuchstaben) die dieser
Auswahl zugewiesen werden soll.
Pro Sektor mssen die Tasten eindeutig sein, ber die FST-Datei
drfen sich die Tasten widerholen!

Das Symbol "&" schliet die Auswahl.

Jede Auswahl darf beliebig viele POS-Statements haben.

Soll eine Position ungebunden bleiben, also ohne Ziel und Taste,
ist folgender Syntax glig:
POS [Pos-Name] ?= .


4. Befehlszeile und Dateianbindung

Der FST-Viewer akzeptiert auf der Kommandozeile eine beliebige
FST-Datei.

Daher ist er auch dazu geeignet als View-Programm zu fungieren,
als Standart-Reaktion auf dem ffnen-Befehl von FST-Dateien.

Ordneroptionen->Dateitypen->Neuer Typ->
*.fst->Vorgang "ffnen"->Anwendung "FST-Viewer.exe" %1


5. Bekannte Bugs

In der Version 2.0 kam ein Bug auf, der aber direkt nicht reproduzierbar ist.
Zu vermeiden sind Kontstruktionen wie:
...% "...
(Formatierungs-Steuerzeichen vor wrtlicher Rede; insbes. das Formatierung-Zurrcksetzen-
Zeichen!)

Fr den Fall, dass der Bug auftritt, einfach einen Zeilenumbruch an der betroffenen Stelle
machen, dann wird dieser behoben.

Ein Bugfix ist in Arbeit.


6. Copyright

(C) 2005 Andreas Haas (Dragon-Shape Software & Entertainment (www.dragon-shape.de))